package com.t.bricks.bussiness.service.common;

import java.util.Date;
import java.util.List;
import java.util.Map;

import com.t.bricks.model.MsgEmity;
import com.t.bricks.model.OrderInfoList;
import com.t.bricks.model.Page;

/**
 * 业务层基类,定义了常用的方法
 * @author huangxinbian
 */
public interface BaseService<T> {

	/**
	 * 检查待新增内容是否存在重复数据(多字段组合重复即重复)集合
	 * 接口内无法定义私有属性,这段代码的作用只是作为提示:要定义此集合,否则无法使用
	 */
	//List<String> checkRepeatCombination;
	
	/**
	 * 检查待新增内容是否存在重复数据(单独字段重复即重复)集合
	 * 接口内无法定义私有属性,这段代码的作用只是作为提示:要定义此集合,否则无法使用
	 */
	//Map<String, Integer> checkRepeatAlone = new HashMap<String, Integer>();
	
	/**
	 * 取检查待新增内容是否存在重复数据(多字段组合重复即重复)集合
	 * @return
	 */
	List<String> getCheckRepeatCombination();
	
	/**
	 * 取检查待新增内容是否存在重复数据(多字段组合重复即重复)集合
	 * @return
	 */
	Map<String, Integer> getCheckRepeatAlone();

	/**
	 * 新增
	 * @param entity 对象实体,注意:跨包访问时可能会是json字符串
	 * @return MsgEmity
	 */
	MsgEmity add(Object entity);
	
	/**
	 * 批量新增
	 * @param entitys 对象实体集合,注意:跨包访问时可能会是json字符串
	 * @return MsgEmity
	 */
	MsgEmity adds(Object entitys);

	/**
	 * 删除
	 * @param iVersion 数据版本号
	 * @param id 编号
	 * @return MsgEmity
	 */
	MsgEmity del(Integer iVersion, Object id);

	/**
	 * 删除
	 * @param iVersion 数据版本号
	 * @param id 编号
	 * @param onlyCreator 仅允许创建者操作
	 * @return MsgEmity
	 */
	MsgEmity del(Integer iVersion, Object id, boolean onlyCreator);

	/**
	 * 批量删除
	 * @Param ids 记录编号集合
	 * @param onlyCreator 仅允许创建者删除
	 * @return MsgEmity
	 */
	MsgEmity dels(List<Object> ids, boolean onlyCreator);

	/**
	 * 修改
	 * @param entity 对象实体,注意:跨包访问时可能会是json字符串
	 * @return MsgEmity
	 */
	MsgEmity edit(Object entity);

	/**
	 * 修改
	 * @param entity 通用对象实体,注意:跨包访问时可能会是json字符串
	 * @param onlyCreator 仅允许创建者操作
	 * @return MsgEmity
	 */
	MsgEmity edit(Object entity, boolean onlyCreator);

	/**
	 * 查询整个表数据
	 * @param onlyCreator 过滤非创建者数据
	 * @return MsgEmity
	 */
	MsgEmity findAll(boolean onlyCreator);
	
	/**
	 * 根据记录编号取对象
	 * @param id 编号
	 * @param onlyCreator 过滤非创建者数据
	 * @return MsgEmity
	 */
	MsgEmity findById(Object id, boolean onlyCreator);
	
	/**
	 * 根据编号集合查询数据
	 * @param ids 编号值集合
	 * @param onlyCreator 过滤非创建者数据
	 * @return MsgEmity
	 */
	MsgEmity findByIds(List<Object> ids, boolean onlyCreator);

	/**
	 * 根据字段名取指定记录编号的数据库表中对应字段的值
	 * @param id 编号
	 * @param fieldNames 待取数据的字段名称集合
	 * @param onlyCreator 过滤非创建者数据
	 * @return MsgEmity 返回内容data中存放的是Map
	 */
	MsgEmity getValueByFieldName(Object id, List<String> fieldNames, boolean onlyCreator);

	/**
	 * 根据关键值取对象集合中的第一个
	 * @param entity 存放查询条件的对象实体,注意:跨包访问时可能会是json字符串
	 * @param onlyCreator 过滤非创建者数据
	 * @return MsgEmity
	 */
	MsgEmity findOneByKey(Object entity, boolean onlyCreator);

	/**
	 * 根据关键值取对象集合
	 * @param entity 存放查询条件的对象实体,注意:跨包访问时可能会是json字符串
	 * @param onlyCreator 过滤非创建者数据
	 * @return MsgEmity
	 */
	MsgEmity findByKey(Object entity, boolean onlyCreator);

	/**
	 * 根据关键值查数量
	 * @Param entity 存放查询条件的CurrentPrice对象,注意:跨包访问时可能会是json字符串
	 * @param onlyCreator 过滤非创建者数据
	 * @return MsgEmity
	 */
	MsgEmity findCountByKey(Object entity, boolean onlyCreator);

	/**
	 * 查询分页
	 * @param page 分页信息对象
	 * @param orders 排序数据集合
	 * @param sLikeStr 全文检索
	 * @param condition 查询条件对象
	 * @return MsgEmity
	 */
	MsgEmity findByPage(Page page, OrderInfoList orders, String sLikeStr,
			Object condition);

	/**
	 * 查询分页
	 * @param page 分页信息对象
	 * @param orders 排序数据集合
	 * @param sLikeStr 全文检索
	 * @param condition 查询条件对象
	 * @param onlyCreator 仅允许创建者操作
	 * @return MsgEmity
	 */
	MsgEmity findByPage(Page page, OrderInfoList orders, String sLikeStr,
			Object condition, boolean onlyCreator);
	
	/**
	 * 查询指定时间内数据
	 * @param sDateSt
	 * @param sDateEd
	 * @param onlyCreator
	 * @return
	 */
	MsgEmity findByDate(String sDateSt, String sDateEd, boolean onlyCreator);
	
	/**
	 * 查询指定时间内数据
	 * @param dDateSt
	 * @param dDateEd
	 * @param onlyCreator
	 * @return
	 */
	MsgEmity findByDate(Date dDateSt, Date dDateEd, boolean onlyCreator);
	
	/**
	 * 查询指定时间内数据
	 * @param sDateSt
	 * @param sDateEd
	 * @return
	 */
	MsgEmity findByDate(String sDateSt, String sDateEd);
	
	/**
	 * 查询指定时间内数据
	 * @param dDateSt
	 * @param dDateEd
	 * @return
	 */
	MsgEmity findByDate(Date dDateSt, Date dDateEd);

	/**
	 * 根据记录编号查询符合分页数据的某条记录
	 * @param id 编号 记录编号
	 * @return MsgEmity
	 */
	MsgEmity findByPageRow(Object id);

	/**
	 * 根据记录编号查询符合分页数据的某条记录
	 * @param id 编号 记录编号
	 * @param onlyCreator 仅创建者可见
	 * @return MsgEmity
	 */
	MsgEmity findByPageRow(Object id, boolean onlyCreator);

	/**
	 * 直接调用数据库操作
	 * @param funName 函数名,因经过一路跳转后,通过函数堆栈方式可能不能正确获取函数名
	 * @param args 参数集合,注意:参数不要使用基本类型
	 * @return MsgEmity
	 */
	MsgEmity callMapping(String funName, Object...args);

	/**
	 * 创建Excel文件内容
	 * @param orders 排序数据集合
	 * @param sLikeStr 全文检索
	 * @param condition 查询条件对象
	 * @return MsgEmity 返回结构中data为创建的经过压缩的Excel内容,接收端需要进行解压,msg为文件名
	 */
	MsgEmity export(OrderInfoList orders, String sLikeStr, Object condition);

	/**
	 * 创建Excel文件内容
	 * @param orders 排序数据集合
	 * @param sLikeStr 全文检索
	 * @param condition 查询条件对象
	 * @param onlyCreator 仅创建者可见
	 * @return MsgEmity 返回结构中data为创建的经过压缩的Excel内容,接收端需要进行解压,msg为文件名
	 */
	MsgEmity export(OrderInfoList orders, String sLikeStr,
			Object condition, boolean onlyCreator);
	
	/**
	 * 修改状态
	 * @param id 编号
	 * @param iState 状态值
	 * @param iVersion 记录版本号
	 * @param sMemo 备注
	 * @return MsgEmity 返回执行情况
	 */
	MsgEmity changeState(Object id, Integer iState, Integer iVersion, String sMemo);
	
	/**
	 * 修改步骤值(如果设置为单向则新值必须大于旧值)
	 * @param id 编号
	 * @param iSetp 步骤值
	 * @param iVersion 记录版本号
	 * @param sMemo 备注
	 * @param unidirectional 是否单向 设置为单向则新值必须大于旧值才能执行
	 * @return MsgEmity 返回执行情况
	 */
	MsgEmity changeSetp(Object id, Integer iState, Integer iVersion,
			String sMemo, boolean unidirectional);
	
	/**
	 * 初始化'检查待新增内容是否存在重复数据'的参数
	 * 执行这个的原因是:当出现模块间互调server方法时会由于变量的设置在controller导致无法获得数据
	 */
	void initCheckRepeatParam();
	
	/**
	 * 验证树形数据待新增的数据是否重复
	 * @param entity
	 * @return
	 */
	MsgEmity validByAdd(T entity);
	
	/**
	 * 检查待修改内容是否存在重复数据(单独字段重复即重复)
	 * @param entity
	 * @return
	 */
	MsgEmity validByEdit(T entity);
	
	/**
	 * 检查是否允许删除数据
	 * @param entity
	 * @return
	 */
	MsgEmity validByDel(Object id);

	/**
	 * 检查待新增内容是否存在重复数据(多字段组合重复即重复)
	 * @param entity
	 * @param checkRepeatMap 查询数据重复的关键字段集合(字段名, 字段值)
	 * @return
	 */
	MsgEmity checkRepeatByAddAndCombination(T entity, Map<String, Object> checkRepeatMap);

	/**
	 * 检查待新增内容是否存在重复数据(多字段组合重复即重复)
	 * @param entity
	 * @param checkRepeatMap 查询数据重复的关键字段集合(字段名, 字段值)
	 * @return
	 */
	MsgEmity checkRepeatByEditAndCombination(T entity, Map<String, Object> checkRepeatMap);

	/**
	 * 检查待修改内容是否存在重复数据(单独字段重复即重复)
	 * @param entity
	 * @param checkRepeatMap 查询数据重复的关键字段集合(字段名, 重复码值)
	 * @return
	 */
	MsgEmity checkRepeatByEditAndAlone(Object entity, Map<String, Integer> checkRepeatMap);
	
	/**
	 * 检查待新增内容是否存在重复数据(单独字段重复即重复)
	 * @param entity
	 * @param checkRepeatMap 查询数据重复的关键字段集合(字段名, 重复码值)
	 * @return
	 */
	MsgEmity checkRepeatByAddAndAlone(Object entity, Map<String, Integer> checkRepeatMap);
	
	/**
	 * 取指定节点下的子节点编号
	 * @param sPid
	 * @return
	 */
	MsgEmity newChildId(String sPid);
	
	/**
	 * 查询树形结构数据
	 * @param entityClass 实体类
	 * @return
	 */
	MsgEmity findByTree();
	
	/**
	 * 清理缓存
	 * @return
	 */
	MsgEmity clearCache();
	
	/**
	 * 清理指定用户的缓存
	 * @param sUser 用户编号
	 * @return
	 */
	MsgEmity clearCache(String sUser);
	
}
